home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Language/OS - Multiplatform Resource Library
/
LANGUAGE OS.iso
/
gnu
/
oleo-1_4.lha
/
oleo-1.4
/
cmd.h
< prev
next >
Wrap
C/C++ Source or Header
|
1993-05-21
|
11KB
|
404 lines
#ifndef CMDH
#define CMDH
/* Copyright (C) 1992, 1993 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this software; see the file COPYING. If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
/* t. lord Wed Oct 14 12:01:37 1992 */
/*
* This file explains the generic interface to interactive functions.
* This covers how C functions are made available to the user, how
* keymaps are structured. This also describes the variables that
* hold the user's interaction state .
*/
#include "global.h"
#include "obstack.h"
#include "line.h"
#include "key.h"
#include "args.h"
#include "funcs.h"
#include "info.h"
#ifdef __STDC__
typedef void (*alarm_fn)(void);
#else
typedef void (*alarm_fn)();
#endif
struct alarm_entry
{
alarm_fn fn;
int freq; /* in seconds. */
time_t last_time;
};
extern struct alarm_entry alarm_table[];
#define cell_timer_seconds (alarm_table[0].freq)
/* Fields prefixed by _ should normally be accessed via the macros
* defined further on.
*/
struct command_frame;
struct macro;
struct input_stream
{
/* The currently executing macro. */
struct macro *_rmac;
unsigned char * _last_macro; /* The last anonymous macro. */
/* If a macro is being exectuted, arguments to a command
* are read from this string.
*/
char *_func_arg;
/* Call stack for macros. */
struct obstack _macro_stack;
/* The macro being recorded, if any. */
unsigned char *_macro;
unsigned char *_macro_start;
unsigned int _macro_size;
/* If this input stream was created only to execute a macro,
* this will point to the input_stream it suspended.
* The purpose of this stack is to give command_loop the ability to
* execute exactly one macro and then return.
*
* Note that within an input stream there is another macro stack.
* That stack is used internally to command_loop.
*/
struct input_stream * prev_stream;
int _pushed_back_char;
};
struct macro
{
struct macro *mac_prev;
unsigned char *mac_exe;
CELLREF mac_row, mac_col;
struct rng mac_rng;
int count; /* Repeat count for this macro. */
unsigned char * mac_start; /* Beginning the current cell's string (as */
/* copied to the macro stack). */
};
/* When a key is bound to a range, that range is stored here and
* the CODE field of the binding is an index. This is bogus.
* Variables should be used.
*/
extern int n_bound_macros;
extern struct rng *bound_macros;
extern int bound_macro_vec;
/* The pattern of interaction is:
* the user selects an interactive function
* a list of arguments to that function are assembled
* the function is called
*
* This type is a union of the types that arguments to interactive
* functions can have.
*/
union command_arg_val
{
char character;
FILE * fp;
int integer;
double floating;
struct key_sequence key; /* Passed as (struct keyseq *). */
struct rng range; /* Passed as (struct rng *). */
char * string;
};
#ifdef __STDC__
typedef void (*direction_function) (int magic, int repeat);
#else
typedef void (*direction_function) ();
#endif
struct command_arg
{
int do_prompt; /* If true, the user gets to edit this. */
int is_set; /* If true, a valid value is stored here. */
struct prompt_style * style; /* The editting mode for this argument. */
char * arg_desc; /* Pointer into FUNC_ARGS of CUR_CMD. */
char * prompt; /* Unexpanded prompt */
char * expanded_prompt;
struct info_buffer * prompt_info;/* Info that should be displayed while */
/* prompting for this argument. */
int info_line; /* First line visible in prompt_info */
struct line text; /* A buffer for the user to edit this value. */
int cursor; /* cursor position of this buffer. */
int overwrite; /* Is overwrite mode on? */
/* For incremental commands. */
direction_function inc_cmd;
/* For reading a character with timeout. */
int timeout_seconds;
/* The value as it will be passed to the cmd function. */
union command_arg_val val;
};
#define MAX_COMMAND_ARGS 10
/* These declarations make up the state of the command interpreter. */
struct command_frame
{
/* If `recursive' edits are enabled, there can be more than one of these. */
struct command_frame * next;
struct command_frame * prev;
struct input_stream * input;
/* The cell being editted (if any). */
CELLREF _setrow;
CELLREF _setcol;
/* The current cell and the mark. */
CELLREF _curow;
CELLREF _cucol;
CELLREF _mkrow;
CELLREF _mkcol;
/* What passes for a window configuration, for now. */
/*
* When the input area is active, it appears to be just another window,
* reachable by other-window. These values must be maintained by any
* implementation of io_get_line.
*/
int _window_after_input; /* Id of the window prior to the input area. */
int _input_active; /* Bool: is the input area selected? */
/* The current top level keymap. */
int top_keymap;
/* Current position in the keymaps. */
int _cur_keymap;
int saved_cur_keymap; /* used when building a prefix arg */
/* The about-to-begin executing command (if any). */
struct cmd_func *_cur_cmd;
short _cur_vector;
/* The last character processed .*/
int _cur_chr;
/* The prefix argument */
int _how_many;
struct line _raw_prefix;
/* This becomes true if the user is ever prompted for arguments
* for this frame.
*/
int complex_to_user;
int _cmd_argc;
int _cur_arg;
struct cmd_func * cmd;
/* The arguments to the current function.
* This is used only if the current function prompts for arguments.
*/
struct command_arg argv[MAX_COMMAND_ARGS];
};
/* When a command is executing, this points to the frame it should operate
* on:
*/
extern struct command_frame * the_cmd_frame;
extern struct command_frame * running_frames;
/* For most code, the structure of command loops and input streams
* is unimportant. To that code, we make it appear that there is just
* a set of global variables.
*/
#define setrow the_cmd_frame->_setrow
#define setcol the_cmd_frame->_setcol
#define curow the_cmd_frame->_curow
#define cucol the_cmd_frame->_cucol
#define mkrow the_cmd_frame->_mkrow
#define mkcol the_cmd_frame->_mkcol
#define window_after_input the_cmd_frame->_window_after_input
#define input_active the_cmd_frame->_input_active
#define cur_keymap the_cmd_frame->_cur_keymap
#define cur_cmd the_cmd_frame->_cur_cmd
#define cur_vector the_cmd_frame->_cur_vector
#define cur_chr the_cmd_frame->_cur_chr
#define cur_arg the_cmd_frame->_cur_arg
#define cmd_argc the_cmd_frame->_cmd_argc
#define how_many the_cmd_frame->_how_many
#define raw_prefix the_cmd_frame->_raw_prefix
#define cur_input the_cmd_frame->input
#define rmac cur_input->_rmac
#define pushed_back_char cur_input->_pushed_back_char
#define last_macro cur_input->_last_macro
#define macro_func_arg cur_input->_func_arg
#define macro_stack cur_input->_macro_stack
#define making_macro cur_input->_macro
#define making_macro_start cur_input->_macro_start
#define making_macro_size cur_input->_macro_size
#define the_cmd_arg the_cmd_frame->argv[cur_arg]
#ifdef FD_SET
#define SELECT_TYPE fd_set
#define SELECT_SET_SIZE FD_SETSIZE
#else /* no FD_SET */
/* Define the macros to access a single-int bitmap of descriptors. */
#define SELECT_SET_SIZE 32
#define SELECT_TYPE int
#define FD_SET(n, p) (*(p) |= (1 << (n)))
#define FD_CLR(n, p) (*(p) &= ~(1 << (n)))
#define FD_ISSET(n, p) (*(p) & (1 << (n)))
#define FD_ZERO(p) (*(p) = 0)
#endif /* no FD_SET */
/* The fd's that are selected on in the interact loop. */
extern SELECT_TYPE read_fd_set;
extern SELECT_TYPE exception_fd_set;
extern SELECT_TYPE write_fd_set;
extern SELECT_TYPE read_pending_fd_set; /* These are the output of select. */
extern SELECT_TYPE exception_pending_fd_set;
extern SELECT_TYPE write_pending_fd_set;
#ifdef __STDC__
typedef void (*select_hook_fn) (int fd);
#else
typedef void (*select_hook_fn) ();
#endif
struct select_hook
{
select_hook_fn hook_fn;
void * jrandom;
};
extern struct select_hook file_read_hooks[SELECT_SET_SIZE];
extern struct select_hook file_exception_hooks[SELECT_SET_SIZE];
extern struct select_hook file_write_hooks[SELECT_SET_SIZE];
#ifdef __STDC__
extern void free_input_stream (struct input_stream * stream);
extern void pop_input_stream (void);
extern void start_entering_macro (void);
extern void bound_macro (int num);
extern void run_string_as_macro (char * macro);
extern void call_last_kbd_macro (int count);
extern void end_macro (void);
extern void stop_entering_macro (void);
extern void store_last_macro (struct rng * rng);
extern int real_get_chr (void);
extern void push_command_frame (struct rng * rng, char * first_line, int len);
extern void remove_cmd_frame (struct command_frame * frame);
extern void free_cmd_frame (struct command_frame * frame);
extern void pop_unfinished_command (void);
extern void recover_from_error (void);
extern void exit_minibuffer (void);
extern void setn_arg_text (struct command_arg * arg, char * text, int len);
extern void init_arg_text (struct command_arg * arg, char * text);
extern void set_default_arg (struct command_arg * arg, char * text, int len);
extern void command_loop (int prefix);
extern void execute_command (char *str);
extern int get_chr (void);
extern void display_error_msg (char * msg, int c);
extern void pushback_keystroke (int c);
extern void io_error_msg (char *str,...);
extern void io_info_msg (char *str,...);
extern char * expand_prompt (char * str);
extern void set_info (char * name);
extern void page_info_backwards (int rep);
extern void page_info (int rep);
extern void view_info (char * name, int ignore);
extern void with_keymap (char * mapname);
extern void one_cmd_with_keymap (char * mapname, struct key_sequence * keyseq);
#else
extern void free_input_stream ();
extern void pop_input_stream ();
extern void start_entering_macro ();
extern void bound_macro ();
extern void run_string_as_macro ();
extern void call_last_kbd_macro ();
extern void end_macro ();
extern void stop_entering_macro ();
extern void store_last_macro ();
extern int real_get_chr ();
extern void push_command_frame ();
extern void remove_cmd_frame ();
extern void free_cmd_frame ();
extern void pop_unfinished_command ();
extern void recover_from_error ();
extern void exit_minibuffer ();
extern void setn_arg_text ();
extern void init_arg_text ();
extern void set_default_arg ();
extern void command_loop ();
extern void execute_command ();
extern int get_chr ();
extern void display_error_msg ();
extern void pushback_keystroke ();
extern void io_error_msg ();
extern void io_info_msg ();
extern char * expand_prompt ();
extern void set_info ();
extern void page_info_backwards ();
extern void page_info ();
extern void view_info ();
extern void with_keymap ();
extern void one_cmd_with_keymap ();
#endif
#endif